sgdk: Sprite Struct Reference

sgdk

- Main Page
- Related Pages
- Classes
- Files

- Class List

Public Attributes
Sprite Struct Reference

`#include <sprite_eng.h>`

List of all members.

## Public Attributes

SpriteDefinition * | definition
Animation * | animation
AnimationFrame * | frame
s16 | x
s16 | y
s16 | animInd
s16 | frameInd
s16 | seqInd
u16 | timer
u16 | attribut
s16 | fixedIndex
u32 | data
s32 | visibility

## Detailed Description

Sprite structure.
Used to manage an active sprite in game condition.

Parameters:

  spriteDef | Sprite definition pointer
  animation | Animation pointer cache
  frame | AnimationFrame pointer cache
  x | current sprite X position
  y | current sprite Y position
  animInd | current animation index
  frameInd | current frame animation index
  seqInd | current frame animation sequence index
  timer | timer for current frame
  attribut | sprite extra attribut (see TILE_ATTR() macro)
  fixedIndex | fixed VRAM tile index for this sprite, by default it is set to -1 for dynamic allocation
  data | misc data to handle sprite (free use for user)
  visibility | visibility flag for each VDP sprite of current frame

The documentation for this struct was generated from the following file:

- sprite_eng.h

All Classes Files Functions Variables Typedefs Enumerations Defines